Module Architecture

flowchart TD
    BASE["sadeem_saas_base\nSAAS Base"]
    NPM["sadeem_nginx_proxy_manager\nNginx Proxy Manager"]
    CF["sadeem_cloudflare\nCloudflare"]

    S["sadeem.subscription\ndomain · DNS · Nginx · DB\nbilling · Git · notifications"]
    ST["sadeem.subscription.stage\ndev / test / prod instances"]
    PKG["sadeem.subscription.package\nOdoo module collections"]
    MOD["sadeem.subscription.module\nOdoo module reference"]
    TPL["sadeem.subscription.db.template\npre-built DB snapshots"]
    BKL["sadeem.subscription.backup.line\nbackup file records"]
    COL["sadeem.subscription.collaborator\nteam access + portal invite"]
    UPD["sadeem.subscription.update.request\nresource upgrade requests"]
    LIM["sadeem.subscription.model.limit\nper-model record limits"]

    BASE --> S
    NPM --> S
    CF --> S

    S --> ST
    S --> PKG
    PKG --> MOD
    PKG --> TPL
    S --> BKL
    S --> COL
    S --> UPD
    S --> LIM

    S --> A1([action_confirm\nvalidate + start provisioning])
    S --> A2([action_run_subscription\nbuild DNS · Nginx · DB])
    S --> A3([action_stop\npause + redirect traffic])
    S --> A4([action_start\nresume stopped subscription])
    S --> A5([action_cancel\ndelete all resources])
    S --> A6([action_get_subscription_info\nGET slave database info])
    S --> A7([action_execute_sql\nrun SQL on slave DB])
    S --> A8([subscription_diagnosis_fix\nfix DNS · Nginx · DB issues])
    S --> A9([action_sync_model_limits\npush limits to slave])
    S --> A10([action_enable_mobile_notifications\nntfy / FCM token setup])
    S --> A11([action_create_portal_user\ncreate portal user on slave])
    S --> A12([action_create_backup_record\nregister with backup server])
    S --> A13([action_get_backup_line\nsync backup list])
    S --> A14([action_create_code_server\ndeploy VS Code container])
    S --> A15([action_install_subscription_modules\ninstall modules on slave DB])

Module Description

Core SaaS subscription lifecycle management. Handles subscription provisioning (DNS, Nginx, database), billing via sale orders and invoices, multi-stage environments, collaborator access with portal invites, backup management, resource upgrade requests, model limits, Git integration, push notifications, SQL console, and customer self-service portal.

Dependencies

• base, web, mail, sale, account, portal
• sadeem_saas_base
• sadeem_nginx_proxy_manager
• sadeem_cloudflare

Menus

SAAS Management
├─ Dashboard
⎢   └─ Subscription Dashboard
├─ Subscriptions
⎢   ├─ Subscriptions
⎢   ├─ Stages
⎢   └─ Update Requests
├─ Data
⎢   ├─ Packages
⎢   ⎢   ├─ Subscription Packages
⎢   ⎢   └─ Subscription Modules
⎢   ├─ Database Templates
⎢   └─ Reserved Domains
└─ Configuration
    └─ Settings

Subscription Lifecycle

The subscription follows a defined state flow from creation to deployment

Draft → Confirm → Build → Run
                    ↓
               Build Failed

Run → Stop → Start (Run)
       ↓
    Terminate / Cancel

Key Fields

Subscription (sadeem.subscription)

Subscription Stage (sadeem.subscription.stage)

Subscription Package (sadeem.subscription.package)

Collaborator (sadeem.subscription.collaborator)

Model Limit (sadeem.subscription.model.limit)

Key Actions

Warnings & Important Notes

• Deletion blocked: Cannot delete a subscription not in draft or cancel state — raises ValidationError.
• Protected subscriptions: Setting protected_subscription = True raises an error if deletion is attempted.
• Domain validation: action_confirm raises UserError if no main domain is defined, ValidationError if the domain is already in use or fails format validation.
• Root server required: action_confirm raises ValidationError if no root server is set when git integration is enabled.
• Destination addons dir required: Raises ValidationError if destination_addons_dir is empty when git is enabled.
• ntfy constraints: action_enable_mobile_notifications raises ValidationError if no ntfy server is configured or auto_generate_tokens is not enabled.
• Nginx host creation failure: action_run_subscription raises ValidationError if Nginx host creation or start fails.
• Cloudflare record failure: action_run_subscription raises ValidationError if DNS record creation fails.
• SQL constraint on UUID: _sql_constraints enforces UNIQUE(uuid) on sadeem.subscription.
• Build step tracking: build_step_dns, build_step_nginx, build_step_instance track which provisioning steps completed; used by subscription_diagnosis_fix to determine what needs repair.
• Secret key required: Encryption operations raise UserError if the sadeem_saas_secret_key system parameter is missing (set by post-install hook in sadeem_saas_base).
• Grace period: Subscriptions with an end_date are not stopped immediately; grace_period adds extra days before the scheduled cron stops them.
• Stage state starts at build: Unlike subscriptions which start at draft, stages default to state build.